Routines (alphabetical) > Routines: H > HDF-EOS Routines > EOS_SW_DEFDIM

EOS_SW_DEFDIM

This function defines dimensions that are used by the field definition functions (described subsequently) to establish the size of the field.

Syntax

Result = EOS_SW_DEFDIM(swathID, fieldname, dim)

Return Value

Returns SUCCEED (0) if successful and FAIL (–1) otherwise.

Arguments

swathID

Swath id (long).

fieldname

Name of dimension (string) to be defined.

dim

The size (long) of the dimension.

Keywords

None

Examples

In this example, we define a track geolocation dimension, GeoTrack, of size 2000, a cross track dimension, GeoXtrack, of size 1000 and two corresponding data dimensions with twice the resolution of the geolocation dimensions:

status = EOS_SW_DEFDIM(swathID, "GeoTrack", 2000)

status = EOS_SW_DEFDIM(swathID, "GeoXtrack", 1000)

status = EOS_SW_DEFDIM(swathID, "DataTrack", 4000)

status = EOS_SW_DEFDIM(swathID, "DataXtrack", 2000)

status = EOS_SW_DEFDIM(swathID, "Bands", 5)

To specify an unlimited dimension that can be used to define an appendable array, the dimension value should be set to zero:

status = EOS_SW_DEFDIM(swathID, "Unlim", 0)

Version History

 

5.2

Introduced